<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page lotroapi.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/src/lotroapi.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-classes">Classes</a>
			|							<a href="#sec-includes">Includes</a>
												</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Distributed under the terms of the Eclipse Public License - v 1.0 (see epl-v10.html)</p>
<p class="description"><p>If you use this software please consider contributing your revisions or extensions back  to the google code project at:             http://code.google.com/p/data-lotro-com-php-helper-class/</p><p>Also consider adding an acknowledgement to your website:   &quot;This site uses the data.lotro.com PHP helper class provided by Chris Thomson and Renkosi.com&quot;</p><p>Please configure the settings in lotroapi.config.php before using this class.</p><p>Example use:</p><p>require_once(&quot;../src/lotroapi.php&quot;);</p><p>$kinship = &quot;Knights+of+the+White+Lady&quot;;</p><p>$world = &quot;Landroval&quot;;</p><p>$player = &quot;Valdidar&quot;;</p><p>$itemid = &quot;1879097424&quot;;</p><p>$api = new api();</p><p>$c = $api-&gt;getCharacterSheet($world, $player); // To fetch a character</p><p>$k = $api-&gt;getGuildRoster($world, $kinship); // to fetch a kinship</p><p>$item = $api-&gt;getItemInformation($itemid); // to fetch item information</p><p>Notes:</p><p>For this class to work the chracter to be viewed must be set as public at my.lotro.com</p><p>Change Log:</p><p>v0.1 - Alpha release for testing. (CTHOMSON - 14/4/2009)</p><p>v0.2 - Added separate config file. (CTHOMSON - 16/5/2009)         Read item information from Lorebook tooltips.         Enhanced data classes with some useful functions.         Oh look documentation!         Fixed a problem with utf8 encoded item names  v0.3 - Added the option to use Curl to get files, incase the server has fopen diasables for URLs  (CTHOMSON - 17/5/2009).         Please note, this build requires PHP5.         To use CURL it must be compiled into PHP.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Chris Thomson &lt;<a href="mailto:renkosi@smog-it.co.uk">renkosi@smog-it.co.uk</a>&gt;</li>
				<li><span class="field">version:</span> 0.3</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009, Chris Thomson</li>
				<li><span class="field">see:</span> <a href="../data.lotro.com PHP Helper Class/_src---lotroapi.config.php.html">lotroapi.config.php</a></li>
				<li><span class="field">filesource:</span> <a href="../__filesource/fsource_data.lotro.com PHP Helper Class__srclotroapi.php.html">Source Code for this file</a></li>
			</ul>
		
			</div>
</div>
		
	<a name="sec-classes"></a>	
	<div class="info-box">
		<div class="info-box-title">Classes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Classes</span>
			|							<a href="#sec-includes">Includes</a>
																		</div>
		<div class="info-box-body">	
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/ErrorCodes.html">ErrorCodes</a>
					</td>
					<td>
											Used to transform a error message into a code.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Api.html">Api</a>
					</td>
					<td>
											Used to access the data.lotro.com API.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/LorebookItem.html">LorebookItem</a>
					</td>
					<td>
											Represents a lorebook item.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Character.html">Character</a>
					</td>
					<td>
											Used to represent a character from the API. This is used both for the character sheets and the Guild listings.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Guild.html">Guild</a>
					</td>
					<td>
											Used to represent a Guild element in the API. Not all of the elements in this class will be populated if  it is created as part of a character sheet call.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Pvmp.html">Pvmp</a>
					</td>
					<td>
											Used to represent the PvMP characteristics of a character from the API
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Vocation.html">Vocation</a>
					</td>
					<td>
											Used to represent the crafting vocation of a player character in the API.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Profession.html">Profession</a>
					</td>
					<td>
											Used to store the crafting Profession of a player character.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Statistic.html">Statistic</a>
					</td>
					<td>
											Represents a player statistic such as morale level.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
						<img src="../media/images/Class.png"
								 alt=" class"
								 title=" class"/>
						<a href="../data.lotro.com PHP Helper Class/Item.html">Item</a>
					</td>
					<td>
											Represents an item summary as returned from an API request. To get the item details use getLorebookItem
										</td>
				</tr>
							</table>
		</div>
	</div>

	<a name="sec-includes"></a>	
	<div class="info-box">
		<div class="info-box-title">Includes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-classes">Classes</a>
				|						<span class="disabled">Includes</span>
														</div>
		<div class="info-box-body">	
			<a name="_lotroapi_config_php"><!-- --></a>
<div class="oddrow">
	
	<div>
		<img src="../media/images/Page.png" alt=" " />
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../data.lotro.com PHP Helper Class/_src---lotroapi.config.php.html">"lotroapi.config.php"</a></span>)
			(line <span class="line-number"><a href="../__filesource/fsource_data.lotro.com PHP Helper Class__srclotroapi.php.html#a67">67</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">USER CONFIGRABLE SETTINGS.</p>
<p class="description"><p>Please edit in the included file</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../data.lotro.com PHP Helper Class/_src---lotroapi.config.php.html">lotroapi.config.php</a></li>
			</ul>
	
</div>
<a name="_htmlentities2_php"><!-- --></a>
<div class="evenrow">
	
	<div>
		<img src="../media/images/Page.png" alt=" " />
		<span class="include-title">
			<span class="include-type">require_once</span>
			(<span class="include-name"><a href="../data.lotro.com PHP Helper Class/_src---htmlentities2.php.html">"htmlentities2.php"</a></span>)
			(line <span class="line-number"><a href="../__filesource/fsource_data.lotro.com PHP Helper Class__srclotroapi.php.html#a79">79</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Used to turn HTML to XML</p>
	
</div>
		</div>
	</div>
	
	
	
	
	<p class="notes" id="credit">
		Documentation generated on Sun, 17 May 2009 13:30:07 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>